<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Entities &mdash; Logtalk APIs v3.93.0-b01 documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d75fae25" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
      <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=0e9007aa" />

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="_static/jquery.js?v=5d32c60e"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="_static/documentation_options.js?v=c8100655"></script>
        <script src="_static/doctools.js?v=9a2dae69"></script>
        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/js/theme.js"></script>
    <!-- begin favicon -->
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" />
    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png" />
    <link rel="manifest" href="/site.webmanifest" />
    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5" />
    <meta name="msapplication-TileColor" content="#355b95" />
    <meta name="theme-color" content="#ffffff" />
    <!-- end favicon -->
    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Predicates" href="predicate_index.html" />
    <link rel="prev" title="Directories" href="directory_index.html" />
   
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="index.html" class="icon icon-home">
            Logtalk APIs
              <img src="_static/logtalk.gif" class="logo" alt="Logo"/>
          </a>
              <div class="version">
                3.93.0
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
    
              <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="library_index.html">Libraries</a></li>
<li class="toctree-l1"><a class="reference internal" href="directory_index.html">Directories</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Entities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#categories">Categories</a><ul>
<li class="toctree-l3"><a class="reference internal" href="arbitrary_0.html">arbitrary</a></li>
<li class="toctree-l3"><a class="reference internal" href="assertions_messages_0.html">assertions_messages</a></li>
<li class="toctree-l3"><a class="reference internal" href="best_first_0.html">best_first</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_hierarchy_0.html">class_hierarchy</a></li>
<li class="toctree-l3"><a class="reference internal" href="code_metric_0.html">code_metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="code_metrics_messages_0.html">code_metrics_messages</a></li>
<li class="toctree-l3"><a class="reference internal" href="code_metrics_utilities_0.html">code_metrics_utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="core_messages_0.html">core_messages</a></li>
<li class="toctree-l3"><a class="reference internal" href="counters_0.html">counters</a></li>
<li class="toctree-l3"><a class="reference internal" href="csv_guess_questions_0.html">csv_guess_questions</a></li>
<li class="toctree-l3"><a class="reference internal" href="dead_code_scanner_messages_0.html">dead_code_scanner_messages</a></li>
<li class="toctree-l3"><a class="reference internal" href="debugger_messages_0.html">debugger_messages</a></li>
<li class="toctree-l3"><a class="reference internal" href="diagram_1.html">diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="directory_diagram_1.html">directory_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="file_diagram_1.html">file_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="flags_0.html">flags</a></li>
<li class="toctree-l3"><a class="reference internal" href="flatting_0.html">flatting</a></li>
<li class="toctree-l3"><a class="reference internal" href="genint_core_0.html">genint_core</a></li>
<li class="toctree-l3"><a class="reference internal" href="gensym_core_0.html">gensym_core</a></li>
<li class="toctree-l3"><a class="reference internal" href="help_info_support_0.html">help_info_support</a></li>
<li class="toctree-l3"><a class="reference internal" href="html_0.html">html</a></li>
<li class="toctree-l3"><a class="reference internal" href="lgtdoc_messages_0.html">lgtdoc_messages</a></li>
<li class="toctree-l3"><a class="reference internal" href="lgtunit_messages_0.html">lgtunit_messages</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_diagram_1.html">library_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="listing_0.html">listing</a></li>
<li class="toctree-l3"><a class="reference internal" href="logging_0.html">logging</a></li>
<li class="toctree-l3"><a class="reference internal" href="monitor_0.html">monitor</a></li>
<li class="toctree-l3"><a class="reference internal" href="mutations_0.html">mutations</a></li>
<li class="toctree-l3"><a class="reference internal" href="observer_0.html">observer</a></li>
<li class="toctree-l3"><a class="reference internal" href="options_0.html">options</a></li>
<li class="toctree-l3"><a class="reference internal" href="os_types_0.html">os_types</a></li>
<li class="toctree-l3"><a class="reference internal" href="packs_common_0.html">packs_common</a></li>
<li class="toctree-l3"><a class="reference internal" href="packs_messages_0.html">packs_messages</a></li>
<li class="toctree-l3"><a class="reference internal" href="proto_hierarchy_0.html">proto_hierarchy</a></li>
<li class="toctree-l3"><a class="reference internal" href="read_file_0.html">read_file</a></li>
<li class="toctree-l3"><a class="reference internal" href="recorded_database_core_0.html">recorded_database_core</a></li>
<li class="toctree-l3"><a class="reference internal" href="statistics_0.html">statistics</a></li>
<li class="toctree-l3"><a class="reference internal" href="subject_0.html">subject</a></li>
<li class="toctree-l3"><a class="reference internal" href="ulid_types_0.html">ulid_types</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#objects">Objects</a><ul>
<li class="toctree-l3"><a class="reference internal" href="a_star_interpreter_1.html">a_star_interpreter(W)</a></li>
<li class="toctree-l3"><a class="reference internal" href="after_event_registry_0.html">after_event_registry</a></li>
<li class="toctree-l3"><a class="reference internal" href="assertions_0.html">assertions</a></li>
<li class="toctree-l3"><a class="reference internal" href="assertions_1.html">assertions(Mode)</a></li>
<li class="toctree-l3"><a class="reference internal" href="assignvars_0.html">assignvars</a></li>
<li class="toctree-l3"><a class="reference internal" href="atom_0.html">atom</a></li>
<li class="toctree-l3"><a class="reference internal" href="atomic_0.html">atomic</a></li>
<li class="toctree-l3"><a class="reference internal" href="automation_report_0.html">automation_report</a></li>
<li class="toctree-l3"><a class="reference internal" href="avltree_0.html">avltree</a></li>
<li class="toctree-l3"><a class="reference internal" href="backend_adapter_hook_0.html">backend_adapter_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="backend_random_0.html">backend_random</a></li>
<li class="toctree-l3"><a class="reference internal" href="base64_0.html">base64</a></li>
<li class="toctree-l3"><a class="reference internal" href="base64url_0.html">base64url</a></li>
<li class="toctree-l3"><a class="reference internal" href="before_event_registry_0.html">before_event_registry</a></li>
<li class="toctree-l3"><a class="reference internal" href="benchmark_generators_0.html">benchmark_generators</a></li>
<li class="toctree-l3"><a class="reference internal" href="bfs_interpreter_0.html">bfs_interpreter</a></li>
<li class="toctree-l3"><a class="reference internal" href="bintree_0.html">bintree</a></li>
<li class="toctree-l3"><a class="reference internal" href="blank_grammars_1.html">blank_grammars(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="bup_interpreter_0.html">bup_interpreter</a></li>
<li class="toctree-l3"><a class="reference internal" href="callable_0.html">callable</a></li>
<li class="toctree-l3"><a class="reference internal" href="cbor_0.html">cbor</a></li>
<li class="toctree-l3"><a class="reference internal" href="cbor_1.html">cbor(StringRepresentation)</a></li>
<li class="toctree-l3"><a class="reference internal" href="cc_metric_0.html">cc_metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="character_0.html">character</a></li>
<li class="toctree-l3"><a class="reference internal" href="code_metrics_0.html">code_metrics</a></li>
<li class="toctree-l3"><a class="reference internal" href="compound_0.html">compound</a></li>
<li class="toctree-l3"><a class="reference internal" href="coroutining_0.html">coroutining</a></li>
<li class="toctree-l3"><a class="reference internal" href="counter_0.html">counter</a></li>
<li class="toctree-l3"><a class="reference internal" href="coupling_metric_0.html">coupling_metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="coverage_report_0.html">coverage_report</a></li>
<li class="toctree-l3"><a class="reference internal" href="csv_0.html">csv</a></li>
<li class="toctree-l3"><a class="reference internal" href="csv_3.html">csv(Header,Separator,IgnoreQuotes)</a></li>
<li class="toctree-l3"><a class="reference internal" href="d2_graph_language_0.html">d2_graph_language</a></li>
<li class="toctree-l3"><a class="reference internal" href="date_0.html">date</a></li>
<li class="toctree-l3"><a class="reference internal" href="dead_code_scanner_0.html">dead_code_scanner</a></li>
<li class="toctree-l3"><a class="reference internal" href="debug_expansion_1.html">debug_expansion(Mode)</a></li>
<li class="toctree-l3"><a class="reference internal" href="debug_messages_0.html">debug_messages</a></li>
<li class="toctree-l3"><a class="reference internal" href="debugger_0.html">debugger</a></li>
<li class="toctree-l3"><a class="reference internal" href="default_atom_mutations_0.html">default_atom_mutations</a></li>
<li class="toctree-l3"><a class="reference internal" href="default_compound_mutations_0.html">default_compound_mutations</a></li>
<li class="toctree-l3"><a class="reference internal" href="default_float_mutations_0.html">default_float_mutations</a></li>
<li class="toctree-l3"><a class="reference internal" href="default_integer_mutations_0.html">default_integer_mutations</a></li>
<li class="toctree-l3"><a class="reference internal" href="default_list_mutations_0.html">default_list_mutations</a></li>
<li class="toctree-l3"><a class="reference internal" href="default_workflow_hook_0.html">default_workflow_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="demodb_0.html">demodb</a></li>
<li class="toctree-l3"><a class="reference internal" href="dfs_interpreter_0.html">dfs_interpreter</a></li>
<li class="toctree-l3"><a class="reference internal" href="diagrams_0.html">diagrams</a></li>
<li class="toctree-l3"><a class="reference internal" href="diagrams_1.html">diagrams(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="dif_0.html">dif</a></li>
<li class="toctree-l3"><a class="reference internal" href="difflist_0.html">difflist</a></li>
<li class="toctree-l3"><a class="reference internal" href="directory_dependency_diagram_0.html">directory_dependency_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="directory_dependency_diagram_1.html">directory_dependency_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="directory_load_diagram_0.html">directory_load_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="directory_load_diagram_1.html">directory_load_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="dit_metric_0.html">dit_metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="doc_metric_0.html">doc_metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="doclet_0.html">doclet</a></li>
<li class="toctree-l3"><a class="reference internal" href="dot_graph_language_0.html">dot_graph_language</a></li>
<li class="toctree-l3"><a class="reference internal" href="dump_trace_0.html">dump_trace</a></li>
<li class="toctree-l3"><a class="reference internal" href="edcg_0.html">edcg</a></li>
<li class="toctree-l3"><a class="reference internal" href="either_0.html">either</a></li>
<li class="toctree-l3"><a class="reference internal" href="entity_diagram_0.html">entity_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="entity_diagram_1.html">entity_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="event_registry_0.html">event_registry</a></li>
<li class="toctree-l3"><a class="reference internal" href="expand_library_alias_paths_0.html">expand_library_alias_paths</a></li>
<li class="toctree-l3"><a class="reference internal" href="expected_0.html">expected</a></li>
<li class="toctree-l3"><a class="reference internal" href="expected_1.html">expected(Expected)</a></li>
<li class="toctree-l3"><a class="reference internal" href="fast_random_0.html">fast_random</a></li>
<li class="toctree-l3"><a class="reference internal" href="fcube_0.html">fcube</a></li>
<li class="toctree-l3"><a class="reference internal" href="file_dependency_diagram_0.html">file_dependency_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="file_dependency_diagram_1.html">file_dependency_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="file_load_diagram_0.html">file_load_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="file_load_diagram_1.html">file_load_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="float_0.html">float</a></li>
<li class="toctree-l3"><a class="reference internal" href="format_0.html">format</a></li>
<li class="toctree-l3"><a class="reference internal" href="genint_0.html">genint</a></li>
<li class="toctree-l3"><a class="reference internal" href="gensym_0.html">gensym</a></li>
<li class="toctree-l3"><a class="reference internal" href="git_0.html">git</a></li>
<li class="toctree-l3"><a class="reference internal" href="grammar_rules_hook_0.html">grammar_rules_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="graph_language_registry_0.html">graph_language_registry</a></li>
<li class="toctree-l3"><a class="reference internal" href="halstead_metric_0.html">halstead_metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="halstead_metric_1.html">halstead_metric(Stroud)</a></li>
<li class="toctree-l3"><a class="reference internal" href="heap_1.html">heap(Order)</a></li>
<li class="toctree-l3"><a class="reference internal" href="help_0.html">help</a></li>
<li class="toctree-l3"><a class="reference internal" href="heuristic_expansion_1.html">heuristic_expansion(Mode)</a></li>
<li class="toctree-l3"><a class="reference internal" href="hook_pipeline_1.html">hook_pipeline(Pipeline)</a></li>
<li class="toctree-l3"><a class="reference internal" href="hook_set_1.html">hook_set(Set)</a></li>
<li class="toctree-l3"><a class="reference internal" href="html5_0.html">html5</a></li>
<li class="toctree-l3"><a class="reference internal" href="iddfs_interpreter_1.html">iddfs_interpreter(Increment)</a></li>
<li class="toctree-l3"><a class="reference internal" href="identity_hook_0.html">identity_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="ids_0.html">ids</a></li>
<li class="toctree-l3"><a class="reference internal" href="ids_2.html">ids(Representation,Bytes)</a></li>
<li class="toctree-l3"><a class="reference internal" href="inheritance_diagram_0.html">inheritance_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="inheritance_diagram_1.html">inheritance_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="integer_0.html">integer</a></li>
<li class="toctree-l3"><a class="reference internal" href="interval_0.html">interval</a></li>
<li class="toctree-l3"><a class="reference internal" href="ip_grammars_1.html">ip_grammars(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="iso8601_0.html">iso8601</a></li>
<li class="toctree-l3"><a class="reference internal" href="issue_creator_0.html">issue_creator</a></li>
<li class="toctree-l3"><a class="reference internal" href="java_0.html">java</a></li>
<li class="toctree-l3"><a class="reference internal" href="java_1.html">java(Reference)</a></li>
<li class="toctree-l3"><a class="reference internal" href="java_2.html">java(Reference,ReturnValue)</a></li>
<li class="toctree-l3"><a class="reference internal" href="java_hook_0.html">java_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="json_0.html">json</a></li>
<li class="toctree-l3"><a class="reference internal" href="json_1.html">json(StringRepresentation)</a></li>
<li class="toctree-l3"><a class="reference internal" href="json_3.html">json(ObjectRepresentation,PairRepresentation,StringRepresentation)</a></li>
<li class="toctree-l3"><a class="reference internal" href="json_lines_0.html">json_lines</a></li>
<li class="toctree-l3"><a class="reference internal" href="json_lines_1.html">json_lines(StringRepresentation)</a></li>
<li class="toctree-l3"><a class="reference internal" href="json_lines_3.html">json_lines(ObjectRepresentation,PairRepresentation,StringRepresentation)</a></li>
<li class="toctree-l3"><a class="reference internal" href="lgtdoc_0.html">lgtdoc</a></li>
<li class="toctree-l3"><a class="reference internal" href="lgtunit_0.html">lgtunit</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_dependency_diagram_0.html">library_dependency_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_dependency_diagram_1.html">library_dependency_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_load_diagram_0.html">library_load_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_load_diagram_1.html">library_load_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="list_0.html">list</a></li>
<li class="toctree-l3"><a class="reference internal" href="list_1.html">list(Type)</a></li>
<li class="toctree-l3"><a class="reference internal" href="logger_0.html">logger</a></li>
<li class="toctree-l3"><a class="reference internal" href="logtalk_0.html">logtalk</a></li>
<li class="toctree-l3"><a class="reference internal" href="loop_0.html">loop</a></li>
<li class="toctree-l3"><a class="reference internal" href="magic_0.html">magic</a></li>
<li class="toctree-l3"><a class="reference internal" href="magic_expansion_1.html">magic_expansion(Mode)</a></li>
<li class="toctree-l3"><a class="reference internal" href="maxheap_0.html">maxheap</a></li>
<li class="toctree-l3"><a class="reference internal" href="maybe_0.html">maybe</a></li>
<li class="toctree-l3"><a class="reference internal" href="meta_0.html">meta</a></li>
<li class="toctree-l3"><a class="reference internal" href="meta_compiler_0.html">meta_compiler</a></li>
<li class="toctree-l3"><a class="reference internal" href="metagol_0.html">metagol</a></li>
<li class="toctree-l3"><a class="reference internal" href="minheap_0.html">minheap</a></li>
<li class="toctree-l3"><a class="reference internal" href="minimal_output_0.html">minimal_output</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules_diagram_support_0.html">modules_diagram_support</a></li>
<li class="toctree-l3"><a class="reference internal" href="mutations_store_0.html">mutations_store</a></li>
<li class="toctree-l3"><a class="reference internal" href="natural_0.html">natural</a></li>
<li class="toctree-l3"><a class="reference internal" href="navltree_0.html">navltree</a></li>
<li class="toctree-l3"><a class="reference internal" href="nbintree_0.html">nbintree</a></li>
<li class="toctree-l3"><a class="reference internal" href="noc_metric_0.html">noc_metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="nor_metric_0.html">nor_metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="nrbtree_0.html">nrbtree</a></li>
<li class="toctree-l3"><a class="reference internal" href="number_0.html">number</a></li>
<li class="toctree-l3"><a class="reference internal" href="number_grammars_1.html">number_grammars(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="numberlist_0.html">numberlist</a></li>
<li class="toctree-l3"><a class="reference internal" href="object_wrapper_hook_0.html">object_wrapper_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="object_wrapper_hook_1.html">object_wrapper_hook(Protocol)</a></li>
<li class="toctree-l3"><a class="reference internal" href="object_wrapper_hook_2.html">object_wrapper_hook(Name,Relations)</a></li>
<li class="toctree-l3"><a class="reference internal" href="optional_0.html">optional</a></li>
<li class="toctree-l3"><a class="reference internal" href="optional_1.html">optional(Optional)</a></li>
<li class="toctree-l3"><a class="reference internal" href="os_0.html">os</a></li>
<li class="toctree-l3"><a class="reference internal" href="packs_0.html">packs</a></li>
<li class="toctree-l3"><a class="reference internal" href="packs_specs_hook_0.html">packs_specs_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="pairs_0.html">pairs</a></li>
<li class="toctree-l3"><a class="reference internal" href="pddl_0.html">pddl</a></li>
<li class="toctree-l3"><a class="reference internal" href="population_0.html">population</a></li>
<li class="toctree-l3"><a class="reference internal" href="ports_profiler_0.html">ports_profiler</a></li>
<li class="toctree-l3"><a class="reference internal" href="print_goal_hook_0.html">print_goal_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="prolog_module_hook_1.html">prolog_module_hook(Module)</a></li>
<li class="toctree-l3"><a class="reference internal" href="queue_0.html">queue</a></li>
<li class="toctree-l3"><a class="reference internal" href="random_0.html">random</a></li>
<li class="toctree-l3"><a class="reference internal" href="rbtree_0.html">rbtree</a></li>
<li class="toctree-l3"><a class="reference internal" href="reader_0.html">reader</a></li>
<li class="toctree-l3"><a class="reference internal" href="recorded_database_0.html">recorded_database</a></li>
<li class="toctree-l3"><a class="reference internal" href="redis_0.html">redis</a></li>
<li class="toctree-l3"><a class="reference internal" href="registries_0.html">registries</a></li>
<li class="toctree-l3"><a class="reference internal" href="registry_loader_hook_0.html">registry_loader_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="rule_expansion_1.html">rule_expansion(Mode)</a></li>
<li class="toctree-l3"><a class="reference internal" href="sample_0.html">sample</a></li>
<li class="toctree-l3"><a class="reference internal" href="sequence_grammars_0.html">sequence_grammars</a></li>
<li class="toctree-l3"><a class="reference internal" href="set_0.html">set</a></li>
<li class="toctree-l3"><a class="reference internal" href="set_1.html">set(Type)</a></li>
<li class="toctree-l3"><a class="reference internal" href="shell_0.html">shell</a></li>
<li class="toctree-l3"><a class="reference internal" href="shell_1.html">shell(Interpreters)</a></li>
<li class="toctree-l3"><a class="reference internal" href="shell_expansion_1.html">shell_expansion(Mode)</a></li>
<li class="toctree-l3"><a class="reference internal" href="size_metric_0.html">size_metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="streamvars_0.html">streamvars</a></li>
<li class="toctree-l3"><a class="reference internal" href="suppress_goal_hook_0.html">suppress_goal_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="tap_output_0.html">tap_output</a></li>
<li class="toctree-l3"><a class="reference internal" href="tap_report_0.html">tap_report</a></li>
<li class="toctree-l3"><a class="reference internal" href="term_0.html">term</a></li>
<li class="toctree-l3"><a class="reference internal" href="term_io_0.html">term_io</a></li>
<li class="toctree-l3"><a class="reference internal" href="time_0.html">time</a></li>
<li class="toctree-l3"><a class="reference internal" href="timeout_0.html">timeout</a></li>
<li class="toctree-l3"><a class="reference internal" href="toychrdb_0.html">toychrdb</a></li>
<li class="toctree-l3"><a class="reference internal" href="tsv_0.html">tsv</a></li>
<li class="toctree-l3"><a class="reference internal" href="tsv_1.html">tsv(Header)</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutor_0.html">tutor</a></li>
<li class="toctree-l3"><a class="reference internal" href="type_0.html">type</a></li>
<li class="toctree-l3"><a class="reference internal" href="ulid_0.html">ulid</a></li>
<li class="toctree-l3"><a class="reference internal" href="ulid_1.html">ulid(Representation)</a></li>
<li class="toctree-l3"><a class="reference internal" href="union_find_0.html">union_find</a></li>
<li class="toctree-l3"><a class="reference internal" href="upn_metric_0.html">upn_metric</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_0.html">user</a></li>
<li class="toctree-l3"><a class="reference internal" href="uses_diagram_0.html">uses_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="uses_diagram_1.html">uses_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="uuid_0.html">uuid</a></li>
<li class="toctree-l3"><a class="reference internal" href="uuid_1.html">uuid(Representation)</a></li>
<li class="toctree-l3"><a class="reference internal" href="varlist_0.html">varlist</a></li>
<li class="toctree-l3"><a class="reference internal" href="wrapper_0.html">wrapper</a></li>
<li class="toctree-l3"><a class="reference internal" href="write_to_file_hook_1.html">write_to_file_hook(File)</a></li>
<li class="toctree-l3"><a class="reference internal" href="write_to_file_hook_2.html">write_to_file_hook(File,Options)</a></li>
<li class="toctree-l3"><a class="reference internal" href="write_to_stream_hook_1.html">write_to_stream_hook(Stream)</a></li>
<li class="toctree-l3"><a class="reference internal" href="write_to_stream_hook_2.html">write_to_stream_hook(Stream,Options)</a></li>
<li class="toctree-l3"><a class="reference internal" href="xhtml11_0.html">xhtml11</a></li>
<li class="toctree-l3"><a class="reference internal" href="xml_0.html">xml</a></li>
<li class="toctree-l3"><a class="reference internal" href="xref_diagram_0.html">xref_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="xref_diagram_1.html">xref_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="xunit_net_v2_output_0.html">xunit_net_v2_output</a></li>
<li class="toctree-l3"><a class="reference internal" href="xunit_net_v2_report_0.html">xunit_net_v2_report</a></li>
<li class="toctree-l3"><a class="reference internal" href="xunit_output_0.html">xunit_output</a></li>
<li class="toctree-l3"><a class="reference internal" href="xunit_report_0.html">xunit_report</a></li>
<li class="toctree-l3"><a class="reference internal" href="zlist_0.html">zlist</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#protocols">Protocols</a><ul>
<li class="toctree-l3"><a class="reference internal" href="assignvarsp_0.html">assignvarsp</a></li>
<li class="toctree-l3"><a class="reference internal" href="characterp_0.html">characterp</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_hierarchyp_0.html">class_hierarchyp</a></li>
<li class="toctree-l3"><a class="reference internal" href="cloning_0.html">cloning</a></li>
<li class="toctree-l3"><a class="reference internal" href="comparingp_0.html">comparingp</a></li>
<li class="toctree-l3"><a class="reference internal" href="csv_protocol_0.html">csv_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="databasep_0.html">databasep</a></li>
<li class="toctree-l3"><a class="reference internal" href="datep_0.html">datep</a></li>
<li class="toctree-l3"><a class="reference internal" href="debuggerp_0.html">debuggerp</a></li>
<li class="toctree-l3"><a class="reference internal" href="dictionaryp_0.html">dictionaryp</a></li>
<li class="toctree-l3"><a class="reference internal" href="event_registryp_0.html">event_registryp</a></li>
<li class="toctree-l3"><a class="reference internal" href="expanding_0.html">expanding</a></li>
<li class="toctree-l3"><a class="reference internal" href="flags_validator_0.html">flags_validator</a></li>
<li class="toctree-l3"><a class="reference internal" href="forwarding_0.html">forwarding</a></li>
<li class="toctree-l3"><a class="reference internal" href="git_protocol_0.html">git_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="graph_language_protocol_0.html">graph_language_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="heapp_0.html">heapp</a></li>
<li class="toctree-l3"><a class="reference internal" href="hierarchyp_0.html">hierarchyp</a></li>
<li class="toctree-l3"><a class="reference internal" href="interpreterp_0.html">interpreterp</a></li>
<li class="toctree-l3"><a class="reference internal" href="intervalp_0.html">intervalp</a></li>
<li class="toctree-l3"><a class="reference internal" href="java_access_protocol_0.html">java_access_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="java_utils_protocol_0.html">java_utils_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="json_lines_protocol_0.html">json_lines_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="json_protocol_0.html">json_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="lgtdocp_0.html">lgtdocp</a></li>
<li class="toctree-l3"><a class="reference internal" href="listp_0.html">listp</a></li>
<li class="toctree-l3"><a class="reference internal" href="loggingp_0.html">loggingp</a></li>
<li class="toctree-l3"><a class="reference internal" href="loopp_0.html">loopp</a></li>
<li class="toctree-l3"><a class="reference internal" href="metagol_example_protocol_0.html">metagol_example_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="metap_0.html">metap</a></li>
<li class="toctree-l3"><a class="reference internal" href="monitoring_0.html">monitoring</a></li>
<li class="toctree-l3"><a class="reference internal" href="monitorp_0.html">monitorp</a></li>
<li class="toctree-l3"><a class="reference internal" href="nested_dictionary_protocol_0.html">nested_dictionary_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="numberlistp_0.html">numberlistp</a></li>
<li class="toctree-l3"><a class="reference internal" href="options_protocol_0.html">options_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="osp_0.html">osp</a></li>
<li class="toctree-l3"><a class="reference internal" href="pack_protocol_0.html">pack_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="proto_hierarchyp_0.html">proto_hierarchyp</a></li>
<li class="toctree-l3"><a class="reference internal" href="pseudo_random_protocol_0.html">pseudo_random_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="queuep_0.html">queuep</a></li>
<li class="toctree-l3"><a class="reference internal" href="random_protocol_0.html">random_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="registry_protocol_0.html">registry_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="sampling_protocol_0.html">sampling_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="setp_0.html">setp</a></li>
<li class="toctree-l3"><a class="reference internal" href="statisticsp_0.html">statisticsp</a></li>
<li class="toctree-l3"><a class="reference internal" href="term_io_protocol_0.html">term_io_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="termp_0.html">termp</a></li>
<li class="toctree-l3"><a class="reference internal" href="timep_0.html">timep</a></li>
<li class="toctree-l3"><a class="reference internal" href="tsv_protocol_0.html">tsv_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="ulid_protocol_0.html">ulid_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="union_find_protocol_0.html">union_find_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="uuid_protocol_0.html">uuid_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="varlistp_0.html">varlistp</a></li>
<li class="toctree-l3"><a class="reference internal" href="zipperp_0.html">zipperp</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="predicate_index.html">Predicates</a></li>
</ul>

    <ul>
    <li class="toctree-l1"><a class="reference internal" href="core_inheritance_diagram.svg">Core diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="library_inheritance_diagram.svg">Libraries diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="tools_inheritance_diagram.svg">Tools diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="ports_inheritance_diagram.svg">Ports diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="contributions_inheritance_diagram.svg">Contributions diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
    </ul>
    <p class="caption"><span class="caption-text">External Contents</span></p>
    <ul>
    <li class="toctree-l1"><a class="reference internal" href="../handbook/index.html">Handbook</a></li>
    <li class="toctree-l1"><a class="reference internal" href="https://logtalk.org">Logtalk website</a></li>
    <li class="toctree-l1"><a class="reference internal" href="https://github.com/LogtalkDotOrg/logtalk3">GitHub repo</a></li>
    </ul>
  
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Logtalk APIs</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">Entities</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/entity_index.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="entities">
<span id="entity-index"></span><h1>Entities<a class="headerlink" href="#entities" title="Link to this heading"></a></h1>
<p>To load an entity, always load the library that includes it using the goal <code class="docutils literal notranslate"><span class="pre">logtalk_load(library_name(loader))</span></code> instead of loading just the entity. The library loader file ensures that all the required dependencies are also loaded and that any required flags are used. The loading goal can be found in the entity documentation.</p>
<section id="categories">
<h2>Categories<a class="headerlink" href="#categories" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="arbitrary_0.html">arbitrary</a></li>
<li class="toctree-l1"><a class="reference internal" href="assertions_messages_0.html">assertions_messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="best_first_0.html">best_first</a></li>
<li class="toctree-l1"><a class="reference internal" href="class_hierarchy_0.html">class_hierarchy</a></li>
<li class="toctree-l1"><a class="reference internal" href="code_metric_0.html">code_metric</a></li>
<li class="toctree-l1"><a class="reference internal" href="code_metrics_messages_0.html">code_metrics_messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="code_metrics_utilities_0.html">code_metrics_utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="core_messages_0.html">core_messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="counters_0.html">counters</a></li>
<li class="toctree-l1"><a class="reference internal" href="csv_guess_questions_0.html">csv_guess_questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="dead_code_scanner_messages_0.html">dead_code_scanner_messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="debugger_messages_0.html">debugger_messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="diagram_1.html">diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="directory_diagram_1.html">directory_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="file_diagram_1.html">file_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="flags_0.html">flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="flatting_0.html">flatting</a></li>
<li class="toctree-l1"><a class="reference internal" href="genint_core_0.html">genint_core</a></li>
<li class="toctree-l1"><a class="reference internal" href="gensym_core_0.html">gensym_core</a></li>
<li class="toctree-l1"><a class="reference internal" href="help_info_support_0.html">help_info_support</a></li>
<li class="toctree-l1"><a class="reference internal" href="html_0.html">html</a></li>
<li class="toctree-l1"><a class="reference internal" href="lgtdoc_messages_0.html">lgtdoc_messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="lgtunit_messages_0.html">lgtunit_messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="library_diagram_1.html">library_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="listing_0.html">listing</a></li>
<li class="toctree-l1"><a class="reference internal" href="logging_0.html">logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="monitor_0.html">monitor</a></li>
<li class="toctree-l1"><a class="reference internal" href="mutations_0.html">mutations</a></li>
<li class="toctree-l1"><a class="reference internal" href="observer_0.html">observer</a></li>
<li class="toctree-l1"><a class="reference internal" href="options_0.html">options</a></li>
<li class="toctree-l1"><a class="reference internal" href="os_types_0.html">os_types</a></li>
<li class="toctree-l1"><a class="reference internal" href="packs_common_0.html">packs_common</a></li>
<li class="toctree-l1"><a class="reference internal" href="packs_messages_0.html">packs_messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="proto_hierarchy_0.html">proto_hierarchy</a></li>
<li class="toctree-l1"><a class="reference internal" href="read_file_0.html">read_file</a></li>
<li class="toctree-l1"><a class="reference internal" href="recorded_database_core_0.html">recorded_database_core</a></li>
<li class="toctree-l1"><a class="reference internal" href="statistics_0.html">statistics</a></li>
<li class="toctree-l1"><a class="reference internal" href="subject_0.html">subject</a></li>
<li class="toctree-l1"><a class="reference internal" href="ulid_types_0.html">ulid_types</a></li>
</ul>
</div>
</section>
<section id="objects">
<h2>Objects<a class="headerlink" href="#objects" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="a_star_interpreter_1.html">a_star_interpreter(W)</a></li>
<li class="toctree-l1"><a class="reference internal" href="after_event_registry_0.html">after_event_registry</a></li>
<li class="toctree-l1"><a class="reference internal" href="assertions_0.html">assertions</a></li>
<li class="toctree-l1"><a class="reference internal" href="assertions_1.html">assertions(Mode)</a></li>
<li class="toctree-l1"><a class="reference internal" href="assignvars_0.html">assignvars</a></li>
<li class="toctree-l1"><a class="reference internal" href="atom_0.html">atom</a></li>
<li class="toctree-l1"><a class="reference internal" href="atomic_0.html">atomic</a></li>
<li class="toctree-l1"><a class="reference internal" href="automation_report_0.html">automation_report</a></li>
<li class="toctree-l1"><a class="reference internal" href="avltree_0.html">avltree</a></li>
<li class="toctree-l1"><a class="reference internal" href="backend_adapter_hook_0.html">backend_adapter_hook</a></li>
<li class="toctree-l1"><a class="reference internal" href="backend_random_0.html">backend_random</a></li>
<li class="toctree-l1"><a class="reference internal" href="base64_0.html">base64</a></li>
<li class="toctree-l1"><a class="reference internal" href="base64url_0.html">base64url</a></li>
<li class="toctree-l1"><a class="reference internal" href="before_event_registry_0.html">before_event_registry</a></li>
<li class="toctree-l1"><a class="reference internal" href="benchmark_generators_0.html">benchmark_generators</a></li>
<li class="toctree-l1"><a class="reference internal" href="bfs_interpreter_0.html">bfs_interpreter</a></li>
<li class="toctree-l1"><a class="reference internal" href="bintree_0.html">bintree</a></li>
<li class="toctree-l1"><a class="reference internal" href="blank_grammars_1.html">blank_grammars(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bup_interpreter_0.html">bup_interpreter</a></li>
<li class="toctree-l1"><a class="reference internal" href="callable_0.html">callable</a></li>
<li class="toctree-l1"><a class="reference internal" href="cbor_0.html">cbor</a></li>
<li class="toctree-l1"><a class="reference internal" href="cbor_1.html">cbor(StringRepresentation)</a></li>
<li class="toctree-l1"><a class="reference internal" href="cc_metric_0.html">cc_metric</a></li>
<li class="toctree-l1"><a class="reference internal" href="character_0.html">character</a></li>
<li class="toctree-l1"><a class="reference internal" href="code_metrics_0.html">code_metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="compound_0.html">compound</a></li>
<li class="toctree-l1"><a class="reference internal" href="coroutining_0.html">coroutining</a></li>
<li class="toctree-l1"><a class="reference internal" href="counter_0.html">counter</a></li>
<li class="toctree-l1"><a class="reference internal" href="coupling_metric_0.html">coupling_metric</a></li>
<li class="toctree-l1"><a class="reference internal" href="coverage_report_0.html">coverage_report</a></li>
<li class="toctree-l1"><a class="reference internal" href="csv_0.html">csv</a></li>
<li class="toctree-l1"><a class="reference internal" href="csv_3.html">csv(Header,Separator,IgnoreQuotes)</a></li>
<li class="toctree-l1"><a class="reference internal" href="d2_graph_language_0.html">d2_graph_language</a></li>
<li class="toctree-l1"><a class="reference internal" href="date_0.html">date</a></li>
<li class="toctree-l1"><a class="reference internal" href="dead_code_scanner_0.html">dead_code_scanner</a></li>
<li class="toctree-l1"><a class="reference internal" href="debug_expansion_1.html">debug_expansion(Mode)</a></li>
<li class="toctree-l1"><a class="reference internal" href="debug_messages_0.html">debug_messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="debugger_0.html">debugger</a></li>
<li class="toctree-l1"><a class="reference internal" href="default_atom_mutations_0.html">default_atom_mutations</a></li>
<li class="toctree-l1"><a class="reference internal" href="default_compound_mutations_0.html">default_compound_mutations</a></li>
<li class="toctree-l1"><a class="reference internal" href="default_float_mutations_0.html">default_float_mutations</a></li>
<li class="toctree-l1"><a class="reference internal" href="default_integer_mutations_0.html">default_integer_mutations</a></li>
<li class="toctree-l1"><a class="reference internal" href="default_list_mutations_0.html">default_list_mutations</a></li>
<li class="toctree-l1"><a class="reference internal" href="default_workflow_hook_0.html">default_workflow_hook</a></li>
<li class="toctree-l1"><a class="reference internal" href="demodb_0.html">demodb</a></li>
<li class="toctree-l1"><a class="reference internal" href="dfs_interpreter_0.html">dfs_interpreter</a></li>
<li class="toctree-l1"><a class="reference internal" href="diagrams_0.html">diagrams</a></li>
<li class="toctree-l1"><a class="reference internal" href="diagrams_1.html">diagrams(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="dif_0.html">dif</a></li>
<li class="toctree-l1"><a class="reference internal" href="difflist_0.html">difflist</a></li>
<li class="toctree-l1"><a class="reference internal" href="directory_dependency_diagram_0.html">directory_dependency_diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="directory_dependency_diagram_1.html">directory_dependency_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="directory_load_diagram_0.html">directory_load_diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="directory_load_diagram_1.html">directory_load_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="dit_metric_0.html">dit_metric</a></li>
<li class="toctree-l1"><a class="reference internal" href="doc_metric_0.html">doc_metric</a></li>
<li class="toctree-l1"><a class="reference internal" href="doclet_0.html">doclet</a></li>
<li class="toctree-l1"><a class="reference internal" href="dot_graph_language_0.html">dot_graph_language</a></li>
<li class="toctree-l1"><a class="reference internal" href="dump_trace_0.html">dump_trace</a></li>
<li class="toctree-l1"><a class="reference internal" href="edcg_0.html">edcg</a></li>
<li class="toctree-l1"><a class="reference internal" href="either_0.html">either</a></li>
<li class="toctree-l1"><a class="reference internal" href="entity_diagram_0.html">entity_diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="entity_diagram_1.html">entity_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_registry_0.html">event_registry</a></li>
<li class="toctree-l1"><a class="reference internal" href="expand_library_alias_paths_0.html">expand_library_alias_paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="expected_0.html">expected</a></li>
<li class="toctree-l1"><a class="reference internal" href="expected_1.html">expected(Expected)</a></li>
<li class="toctree-l1"><a class="reference internal" href="fast_random_0.html">fast_random</a></li>
<li class="toctree-l1"><a class="reference internal" href="fcube_0.html">fcube</a></li>
<li class="toctree-l1"><a class="reference internal" href="file_dependency_diagram_0.html">file_dependency_diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="file_dependency_diagram_1.html">file_dependency_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="file_load_diagram_0.html">file_load_diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="file_load_diagram_1.html">file_load_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="float_0.html">float</a></li>
<li class="toctree-l1"><a class="reference internal" href="format_0.html">format</a></li>
<li class="toctree-l1"><a class="reference internal" href="genint_0.html">genint</a></li>
<li class="toctree-l1"><a class="reference internal" href="gensym_0.html">gensym</a></li>
<li class="toctree-l1"><a class="reference internal" href="git_0.html">git</a></li>
<li class="toctree-l1"><a class="reference internal" href="grammar_rules_hook_0.html">grammar_rules_hook</a></li>
<li class="toctree-l1"><a class="reference internal" href="graph_language_registry_0.html">graph_language_registry</a></li>
<li class="toctree-l1"><a class="reference internal" href="halstead_metric_0.html">halstead_metric</a></li>
<li class="toctree-l1"><a class="reference internal" href="halstead_metric_1.html">halstead_metric(Stroud)</a></li>
<li class="toctree-l1"><a class="reference internal" href="heap_1.html">heap(Order)</a></li>
<li class="toctree-l1"><a class="reference internal" href="help_0.html">help</a></li>
<li class="toctree-l1"><a class="reference internal" href="heuristic_expansion_1.html">heuristic_expansion(Mode)</a></li>
<li class="toctree-l1"><a class="reference internal" href="hook_pipeline_1.html">hook_pipeline(Pipeline)</a></li>
<li class="toctree-l1"><a class="reference internal" href="hook_set_1.html">hook_set(Set)</a></li>
<li class="toctree-l1"><a class="reference internal" href="html5_0.html">html5</a></li>
<li class="toctree-l1"><a class="reference internal" href="iddfs_interpreter_1.html">iddfs_interpreter(Increment)</a></li>
<li class="toctree-l1"><a class="reference internal" href="identity_hook_0.html">identity_hook</a></li>
<li class="toctree-l1"><a class="reference internal" href="ids_0.html">ids</a></li>
<li class="toctree-l1"><a class="reference internal" href="ids_2.html">ids(Representation,Bytes)</a></li>
<li class="toctree-l1"><a class="reference internal" href="inheritance_diagram_0.html">inheritance_diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="inheritance_diagram_1.html">inheritance_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="integer_0.html">integer</a></li>
<li class="toctree-l1"><a class="reference internal" href="interval_0.html">interval</a></li>
<li class="toctree-l1"><a class="reference internal" href="ip_grammars_1.html">ip_grammars(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="iso8601_0.html">iso8601</a></li>
<li class="toctree-l1"><a class="reference internal" href="issue_creator_0.html">issue_creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="java_0.html">java</a></li>
<li class="toctree-l1"><a class="reference internal" href="java_1.html">java(Reference)</a></li>
<li class="toctree-l1"><a class="reference internal" href="java_2.html">java(Reference,ReturnValue)</a></li>
<li class="toctree-l1"><a class="reference internal" href="java_hook_0.html">java_hook</a></li>
<li class="toctree-l1"><a class="reference internal" href="json_0.html">json</a></li>
<li class="toctree-l1"><a class="reference internal" href="json_1.html">json(StringRepresentation)</a></li>
<li class="toctree-l1"><a class="reference internal" href="json_3.html">json(ObjectRepresentation,PairRepresentation,StringRepresentation)</a></li>
<li class="toctree-l1"><a class="reference internal" href="json_lines_0.html">json_lines</a></li>
<li class="toctree-l1"><a class="reference internal" href="json_lines_1.html">json_lines(StringRepresentation)</a></li>
<li class="toctree-l1"><a class="reference internal" href="json_lines_3.html">json_lines(ObjectRepresentation,PairRepresentation,StringRepresentation)</a></li>
<li class="toctree-l1"><a class="reference internal" href="lgtdoc_0.html">lgtdoc</a></li>
<li class="toctree-l1"><a class="reference internal" href="lgtunit_0.html">lgtunit</a></li>
<li class="toctree-l1"><a class="reference internal" href="library_dependency_diagram_0.html">library_dependency_diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="library_dependency_diagram_1.html">library_dependency_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="library_load_diagram_0.html">library_load_diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="library_load_diagram_1.html">library_load_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="list_0.html">list</a></li>
<li class="toctree-l1"><a class="reference internal" href="list_1.html">list(Type)</a></li>
<li class="toctree-l1"><a class="reference internal" href="logger_0.html">logger</a></li>
<li class="toctree-l1"><a class="reference internal" href="logtalk_0.html">logtalk</a></li>
<li class="toctree-l1"><a class="reference internal" href="loop_0.html">loop</a></li>
<li class="toctree-l1"><a class="reference internal" href="magic_0.html">magic</a></li>
<li class="toctree-l1"><a class="reference internal" href="magic_expansion_1.html">magic_expansion(Mode)</a></li>
<li class="toctree-l1"><a class="reference internal" href="maxheap_0.html">maxheap</a></li>
<li class="toctree-l1"><a class="reference internal" href="maybe_0.html">maybe</a></li>
<li class="toctree-l1"><a class="reference internal" href="meta_0.html">meta</a></li>
<li class="toctree-l1"><a class="reference internal" href="meta_compiler_0.html">meta_compiler</a></li>
<li class="toctree-l1"><a class="reference internal" href="metagol_0.html">metagol</a></li>
<li class="toctree-l1"><a class="reference internal" href="minheap_0.html">minheap</a></li>
<li class="toctree-l1"><a class="reference internal" href="minimal_output_0.html">minimal_output</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules_diagram_support_0.html">modules_diagram_support</a></li>
<li class="toctree-l1"><a class="reference internal" href="mutations_store_0.html">mutations_store</a></li>
<li class="toctree-l1"><a class="reference internal" href="natural_0.html">natural</a></li>
<li class="toctree-l1"><a class="reference internal" href="navltree_0.html">navltree</a></li>
<li class="toctree-l1"><a class="reference internal" href="nbintree_0.html">nbintree</a></li>
<li class="toctree-l1"><a class="reference internal" href="noc_metric_0.html">noc_metric</a></li>
<li class="toctree-l1"><a class="reference internal" href="nor_metric_0.html">nor_metric</a></li>
<li class="toctree-l1"><a class="reference internal" href="nrbtree_0.html">nrbtree</a></li>
<li class="toctree-l1"><a class="reference internal" href="number_0.html">number</a></li>
<li class="toctree-l1"><a class="reference internal" href="number_grammars_1.html">number_grammars(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="numberlist_0.html">numberlist</a></li>
<li class="toctree-l1"><a class="reference internal" href="object_wrapper_hook_0.html">object_wrapper_hook</a></li>
<li class="toctree-l1"><a class="reference internal" href="object_wrapper_hook_1.html">object_wrapper_hook(Protocol)</a></li>
<li class="toctree-l1"><a class="reference internal" href="object_wrapper_hook_2.html">object_wrapper_hook(Name,Relations)</a></li>
<li class="toctree-l1"><a class="reference internal" href="optional_0.html">optional</a></li>
<li class="toctree-l1"><a class="reference internal" href="optional_1.html">optional(Optional)</a></li>
<li class="toctree-l1"><a class="reference internal" href="os_0.html">os</a></li>
<li class="toctree-l1"><a class="reference internal" href="packs_0.html">packs</a></li>
<li class="toctree-l1"><a class="reference internal" href="packs_specs_hook_0.html">packs_specs_hook</a></li>
<li class="toctree-l1"><a class="reference internal" href="pairs_0.html">pairs</a></li>
<li class="toctree-l1"><a class="reference internal" href="pddl_0.html">pddl</a></li>
<li class="toctree-l1"><a class="reference internal" href="population_0.html">population</a></li>
<li class="toctree-l1"><a class="reference internal" href="ports_profiler_0.html">ports_profiler</a></li>
<li class="toctree-l1"><a class="reference internal" href="print_goal_hook_0.html">print_goal_hook</a></li>
<li class="toctree-l1"><a class="reference internal" href="prolog_module_hook_1.html">prolog_module_hook(Module)</a></li>
<li class="toctree-l1"><a class="reference internal" href="queue_0.html">queue</a></li>
<li class="toctree-l1"><a class="reference internal" href="random_0.html">random</a></li>
<li class="toctree-l1"><a class="reference internal" href="rbtree_0.html">rbtree</a></li>
<li class="toctree-l1"><a class="reference internal" href="reader_0.html">reader</a></li>
<li class="toctree-l1"><a class="reference internal" href="recorded_database_0.html">recorded_database</a></li>
<li class="toctree-l1"><a class="reference internal" href="redis_0.html">redis</a></li>
<li class="toctree-l1"><a class="reference internal" href="registries_0.html">registries</a></li>
<li class="toctree-l1"><a class="reference internal" href="registry_loader_hook_0.html">registry_loader_hook</a></li>
<li class="toctree-l1"><a class="reference internal" href="rule_expansion_1.html">rule_expansion(Mode)</a></li>
<li class="toctree-l1"><a class="reference internal" href="sample_0.html">sample</a></li>
<li class="toctree-l1"><a class="reference internal" href="sequence_grammars_0.html">sequence_grammars</a></li>
<li class="toctree-l1"><a class="reference internal" href="set_0.html">set</a></li>
<li class="toctree-l1"><a class="reference internal" href="set_1.html">set(Type)</a></li>
<li class="toctree-l1"><a class="reference internal" href="shell_0.html">shell</a></li>
<li class="toctree-l1"><a class="reference internal" href="shell_1.html">shell(Interpreters)</a></li>
<li class="toctree-l1"><a class="reference internal" href="shell_expansion_1.html">shell_expansion(Mode)</a></li>
<li class="toctree-l1"><a class="reference internal" href="size_metric_0.html">size_metric</a></li>
<li class="toctree-l1"><a class="reference internal" href="streamvars_0.html">streamvars</a></li>
<li class="toctree-l1"><a class="reference internal" href="suppress_goal_hook_0.html">suppress_goal_hook</a></li>
<li class="toctree-l1"><a class="reference internal" href="tap_output_0.html">tap_output</a></li>
<li class="toctree-l1"><a class="reference internal" href="tap_report_0.html">tap_report</a></li>
<li class="toctree-l1"><a class="reference internal" href="term_0.html">term</a></li>
<li class="toctree-l1"><a class="reference internal" href="term_io_0.html">term_io</a></li>
<li class="toctree-l1"><a class="reference internal" href="time_0.html">time</a></li>
<li class="toctree-l1"><a class="reference internal" href="timeout_0.html">timeout</a></li>
<li class="toctree-l1"><a class="reference internal" href="toychrdb_0.html">toychrdb</a></li>
<li class="toctree-l1"><a class="reference internal" href="tsv_0.html">tsv</a></li>
<li class="toctree-l1"><a class="reference internal" href="tsv_1.html">tsv(Header)</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutor_0.html">tutor</a></li>
<li class="toctree-l1"><a class="reference internal" href="type_0.html">type</a></li>
<li class="toctree-l1"><a class="reference internal" href="ulid_0.html">ulid</a></li>
<li class="toctree-l1"><a class="reference internal" href="ulid_1.html">ulid(Representation)</a></li>
<li class="toctree-l1"><a class="reference internal" href="union_find_0.html">union_find</a></li>
<li class="toctree-l1"><a class="reference internal" href="upn_metric_0.html">upn_metric</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_0.html">user</a></li>
<li class="toctree-l1"><a class="reference internal" href="uses_diagram_0.html">uses_diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="uses_diagram_1.html">uses_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="uuid_0.html">uuid</a></li>
<li class="toctree-l1"><a class="reference internal" href="uuid_1.html">uuid(Representation)</a></li>
<li class="toctree-l1"><a class="reference internal" href="varlist_0.html">varlist</a></li>
<li class="toctree-l1"><a class="reference internal" href="wrapper_0.html">wrapper</a></li>
<li class="toctree-l1"><a class="reference internal" href="write_to_file_hook_1.html">write_to_file_hook(File)</a></li>
<li class="toctree-l1"><a class="reference internal" href="write_to_file_hook_2.html">write_to_file_hook(File,Options)</a></li>
<li class="toctree-l1"><a class="reference internal" href="write_to_stream_hook_1.html">write_to_stream_hook(Stream)</a></li>
<li class="toctree-l1"><a class="reference internal" href="write_to_stream_hook_2.html">write_to_stream_hook(Stream,Options)</a></li>
<li class="toctree-l1"><a class="reference internal" href="xhtml11_0.html">xhtml11</a></li>
<li class="toctree-l1"><a class="reference internal" href="xml_0.html">xml</a></li>
<li class="toctree-l1"><a class="reference internal" href="xref_diagram_0.html">xref_diagram</a></li>
<li class="toctree-l1"><a class="reference internal" href="xref_diagram_1.html">xref_diagram(Format)</a></li>
<li class="toctree-l1"><a class="reference internal" href="xunit_net_v2_output_0.html">xunit_net_v2_output</a></li>
<li class="toctree-l1"><a class="reference internal" href="xunit_net_v2_report_0.html">xunit_net_v2_report</a></li>
<li class="toctree-l1"><a class="reference internal" href="xunit_output_0.html">xunit_output</a></li>
<li class="toctree-l1"><a class="reference internal" href="xunit_report_0.html">xunit_report</a></li>
<li class="toctree-l1"><a class="reference internal" href="zlist_0.html">zlist</a></li>
</ul>
</div>
</section>
<section id="protocols">
<h2>Protocols<a class="headerlink" href="#protocols" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="assignvarsp_0.html">assignvarsp</a></li>
<li class="toctree-l1"><a class="reference internal" href="characterp_0.html">characterp</a></li>
<li class="toctree-l1"><a class="reference internal" href="class_hierarchyp_0.html">class_hierarchyp</a></li>
<li class="toctree-l1"><a class="reference internal" href="cloning_0.html">cloning</a></li>
<li class="toctree-l1"><a class="reference internal" href="comparingp_0.html">comparingp</a></li>
<li class="toctree-l1"><a class="reference internal" href="csv_protocol_0.html">csv_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="databasep_0.html">databasep</a></li>
<li class="toctree-l1"><a class="reference internal" href="datep_0.html">datep</a></li>
<li class="toctree-l1"><a class="reference internal" href="debuggerp_0.html">debuggerp</a></li>
<li class="toctree-l1"><a class="reference internal" href="dictionaryp_0.html">dictionaryp</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_registryp_0.html">event_registryp</a></li>
<li class="toctree-l1"><a class="reference internal" href="expanding_0.html">expanding</a></li>
<li class="toctree-l1"><a class="reference internal" href="flags_validator_0.html">flags_validator</a></li>
<li class="toctree-l1"><a class="reference internal" href="forwarding_0.html">forwarding</a></li>
<li class="toctree-l1"><a class="reference internal" href="git_protocol_0.html">git_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="graph_language_protocol_0.html">graph_language_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="heapp_0.html">heapp</a></li>
<li class="toctree-l1"><a class="reference internal" href="hierarchyp_0.html">hierarchyp</a></li>
<li class="toctree-l1"><a class="reference internal" href="interpreterp_0.html">interpreterp</a></li>
<li class="toctree-l1"><a class="reference internal" href="intervalp_0.html">intervalp</a></li>
<li class="toctree-l1"><a class="reference internal" href="java_access_protocol_0.html">java_access_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="java_utils_protocol_0.html">java_utils_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="json_lines_protocol_0.html">json_lines_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="json_protocol_0.html">json_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="lgtdocp_0.html">lgtdocp</a></li>
<li class="toctree-l1"><a class="reference internal" href="listp_0.html">listp</a></li>
<li class="toctree-l1"><a class="reference internal" href="loggingp_0.html">loggingp</a></li>
<li class="toctree-l1"><a class="reference internal" href="loopp_0.html">loopp</a></li>
<li class="toctree-l1"><a class="reference internal" href="metagol_example_protocol_0.html">metagol_example_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="metap_0.html">metap</a></li>
<li class="toctree-l1"><a class="reference internal" href="monitoring_0.html">monitoring</a></li>
<li class="toctree-l1"><a class="reference internal" href="monitorp_0.html">monitorp</a></li>
<li class="toctree-l1"><a class="reference internal" href="nested_dictionary_protocol_0.html">nested_dictionary_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="numberlistp_0.html">numberlistp</a></li>
<li class="toctree-l1"><a class="reference internal" href="options_protocol_0.html">options_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="osp_0.html">osp</a></li>
<li class="toctree-l1"><a class="reference internal" href="pack_protocol_0.html">pack_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="proto_hierarchyp_0.html">proto_hierarchyp</a></li>
<li class="toctree-l1"><a class="reference internal" href="pseudo_random_protocol_0.html">pseudo_random_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="queuep_0.html">queuep</a></li>
<li class="toctree-l1"><a class="reference internal" href="random_protocol_0.html">random_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="registry_protocol_0.html">registry_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="sampling_protocol_0.html">sampling_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="setp_0.html">setp</a></li>
<li class="toctree-l1"><a class="reference internal" href="statisticsp_0.html">statisticsp</a></li>
<li class="toctree-l1"><a class="reference internal" href="term_io_protocol_0.html">term_io_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="termp_0.html">termp</a></li>
<li class="toctree-l1"><a class="reference internal" href="timep_0.html">timep</a></li>
<li class="toctree-l1"><a class="reference internal" href="tsv_protocol_0.html">tsv_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="ulid_protocol_0.html">ulid_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="union_find_protocol_0.html">union_find_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="uuid_protocol_0.html">uuid_protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="varlistp_0.html">varlistp</a></li>
<li class="toctree-l1"><a class="reference internal" href="zipperp_0.html">zipperp</a></li>
</ul>
</div>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="directory_index.html" class="btn btn-neutral float-left" title="Directories" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="predicate_index.html" class="btn btn-neutral float-right" title="Predicates" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 1998-2025, Paulo Moura.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>